Архивирование сотрудника

Запрос позволяет архивировать сотрудника клиента. При архивации сотрудник пропадает из личного кабинета. Сотрудник не может пользоваться сервисами, и его нельзя найти в личном кабинете.

При попытке создать сотрудника с таким же номером телефона, как и у архивированного сотрудника, возникнет ошибка.
В этом случае вместо создания нового сотрудника следует восстановить сотрудника из архива с обновленными данными.

Синтаксис запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/users/archive?user_id={идентификатор сотрудника}

Заголовки запроса

• Authorization: Bearer <OAuth-токен>
  Процесс получения токена описан в разделе Начало работы.

• X-YaTaxi-Selected-Corp-Client-Id — ID клиента из Личного кабинета. Обязателен, если по токену доступно несколько клиентов.

Параметры запроса

Запрос содержит обязательный параметр:

• user_id — идентификатор сотрудника, информация по которому архивируется.

Описание полей ответа

В ответе содержится поле:

Пример запроса

POST https://b2b-api.go.yandex.ru/integration/2.0/users/archive?user_id=f65...c57d
...
Authorization: Bearer <OAuth-token>
X-YaTaxi-Selected-Corp-Client-Id: <client-id>

Пример ответа

Пример ответа на данный запрос выглядит следующим образом:

{
    "status": "OK"
}

Возможные коды ответа

Ответ на данный запрос может содержать следующие стандартные HTTP-коды:

• 200 — запрос выполнен успешно.
• 401 — был передан неверный OAuth-токен.
• 403 — у клиента не хватает прав на выполнение данного запроса.
  • SELECT_CLIENT_HEADER_REQUIRED: в запросе не передан заголовок X-YaTaxi-Selected-Corp-Client-Id (возвращается в случае, если для токена доступно более одного клиента).
  • SELECTED_CLIENT_ACCESS_DENIED: в заголовке X-YaTaxi-Selected-Corp-Client-Id передан ID клиента, к которому нет доступа у этого логина.
• 404 — запрашиваемая запись не найдена.

Восстановление архивированного сотрудника

Для восстановления нужно отправить запрос на редактирование сотрудника с добавлением флага is_deleted: false.